home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1997 July / EnigmA AMIGA RUN 20 (1997)(G.R. Edizioni)(IT)[!][issue 1997-07 & 08][EAR-CD IV].iso / earcd / text / edit / vim46src.lha / vim-4.6 / src / INSTALL < prev    next >
Text File  |  2000-06-08  |  15KB  |  394 lines
  1. INSTALL - Installation of Vim on different machines.
  2.  
  3. This file contains instructions for compiling Vim. If you have an executable
  4. version of Vim, you don't need this.
  5.  
  6. Contents:
  7. 1. Generic
  8. 2. Amiga
  9. 3. MS-DOS
  10. 4. Win32 (Windows NT and Windows 95)
  11. 5. Archimedes
  12. 6. Macintosh
  13. 7. Unix
  14. 8. OS/2 (with EMX 0.9b)
  15. 9. Atari MiNT
  16.  
  17.  
  18. 1. Generic
  19. ==========
  20.  
  21. The file "feature.h" can be edited to match your preferences. You can skip
  22. this, then you will get the default behaviour as is documented, which should
  23. be fine for most people.
  24.  
  25.  
  26. 2. Amiga
  27. ========
  28.  
  29. Summary:
  30. make -f makefile.manx        Manx C
  31. make -f makefile.sas        Lattice/SAS C
  32. make -f makefile.dice        DICE
  33.  
  34. The Manx compiler is preferred, it was used to produce the Amiga executable
  35. and has been tested most. You should not get any errors or warnings.
  36.  
  37. The SAS compiler can be used. Older versions (6.0 to 6.3) don't work with the
  38. optimizer switched on. This seems to be fixed with 6.5 or 6.56, but this has
  39. not been tested much.
  40.  
  41. The DICE makefile works, but it has only been tested by one person.
  42.  
  43. You will have to set the "VIM" environment variable to the location of the
  44. documentation files.
  45.  
  46.  
  47. 3. MS-DOS
  48. =========
  49.  
  50. Summary:
  51. ren makefile makefile.uni
  52. ren makefile.bcc makefile; make        Borland C++ and Turbo C++
  53. ren makefile.dos makefile; make        Turbo C
  54. make -f makefile.djg            DJGPP 2.0
  55.  
  56. Warning: Be sure to use the right make.exe.  Microsoft C make doesn't work;
  57. Borland make only works with makefile.bcc and makefile.dos; DJGPP/GNU make
  58. must be used for makefile.djg.
  59.  
  60. The Borland C++ compiler has been used to generate the MS-DOS executable; it
  61. should work without problems. You will probably have to change the paths for
  62. LIBPATH and INCLUDEPATH in the start of the makefile. If you don't have the
  63. spawno library, try to get it (e.g., from Simtel), or follow the instructions
  64. in the makefile to remove the use of spawno. You will get two warnings which
  65. can be ignored (one about _chmod and one about precompiled header files).
  66.  
  67. The Turbo C makefile has not been tested much lately. It is included for those
  68. that don't have C++. You may need to make a few changes to get it to work.
  69.  
  70. DJGPP needs to be installed properly to compile Vim; you need a lot of things
  71. before it works. When your setup is OK, Vim should compile with just one
  72. warning (about an argument to signal()).
  73.  
  74. You will have to set the "VIM" environment variable to the location of the
  75. documentation files.
  76.  
  77.  
  78. 4. Win32 (Windows NT and Windows 95)
  79. ====================================
  80.  
  81. Summary:
  82. nmake -f Makefile.w32        Win32 SDK or Microsoft Visual C++
  83. make -f Makefile.b32        Borland C++ 4.5
  84.  
  85. These files have been supplied by George V. Reilly and Ben Singer; they should
  86. work.  Makefile.b32 has not been tested much; use Makefile.w32 if you can.
  87.  
  88. You will have to set the "VIM" environment variable to the location of the
  89. documentation files.
  90.  
  91.  
  92. 5. Archimedes
  93. =============
  94.  
  95. make -f makefile.arch
  96.  
  97. This probably doesn't work, since the include file archie.h is still missing.
  98. Nobody is currently working on this.
  99.  
  100.  
  101. 6. Macintosh
  102. ============
  103.  
  104. Vim should work on the Macintosh, but I don't have a makefile for it.
  105. Work is being done to update the Macintosh port.  It's a lot of work; don't
  106. expect it soon.
  107.  
  108.  
  109. 7. Unix
  110. =======
  111.  
  112. Summary:
  113. 1. make            run configure, compile and link
  114. 2. make install        installation in /usr/local
  115.  
  116. This will include the GUI and X11 libraries, if you have them.  If you want a
  117. version of Vim that is small and starts up quickly, see the Makefile for how to
  118. disable the GUI and X11.  If you don't have Motif and/or X11, these features
  119. will be disabled automatically.
  120.  
  121. See the start of Makefile for more detailed instructions about how to compile
  122. Vim.
  123.  
  124. If you are compiling Vim for several machines, for each machine:
  125.   a.    make shadow
  126.   b.    mv shadow machine_name
  127.   c.    cd machine_name
  128.   d.    points 1 and 2 above
  129.  
  130. [don't use a path for machine_name, just a directory name, otherwise the links
  131. that "make shadow" create won't work]
  132.  
  133. GNU Autoconf and a few other tools have been used to make Vim work on many
  134. different Unix systems. The advantage of this is that Vim should compile
  135. on most sytems without any adjustments. The disadvantage is that when
  136. adjustments are required, it takes some time to understand what is happening.
  137.  
  138. If configure finds all library files and then complains when linking that some
  139. of them can't be found, your linker doesn't return an error code for missing
  140. libraries.  Vim should be linked fine anyway; just ignore these errors.
  141.  
  142. On Linux, when using -g to compile (which is default for gcc), the executable
  143. will probably be statically linked.  If you don't want this, remove the -g
  144. option from CFLAGS.
  145.  
  146. If you run configure by hand (not using the Makefile), remember that any
  147. changes in the Makefile have no influence on configure.  This may be what you
  148. want, but maybe not!
  149.  
  150.  
  151. 8. OS/2
  152. =======
  153.  
  154. Summary:
  155. ren Makefile Makefile.unix
  156. ren makefile.os2 Makefile
  157. make
  158.  
  159. This port of Vim to OS/2 is based on the emx environment together
  160. with GNU C. The main design goal of emx is to simplify porting Unix
  161. software to OS/2 and DOS. Because of this, almost all the Unix defines
  162. etc. already existing in the Vim source code could be reused. Only where
  163. OS/2 specifics came into play were additional changes necessary. Those
  164. places can be found by searching for "OS2" and "__EMX__" (I've tried to
  165. keep emx-specific things separate from generic OS/2 stuff).
  166.  
  167. Note: This OS/2 port works well for me and an additional OS/2 user on
  168.       the Vim development team (Karsten Sievert); however, since I
  169.       haven't had any other feedback from other people, that either
  170.       means no (OS/2-specific) bugs exist, or no one has yet created
  171.       a situation in which any bugs are apparent.
  172.       Report any problems or other comments to paul@wau.mis.ah.nl
  173.       (email valid up to at least September 1996, after that try
  174.       paul@wurtel.hobby.nl, paul@murphy.nl, or paulS@toecompst.nl).
  175.       Textmode/notextmode and binary mode both seem to work well.
  176.  
  177. Prerequisites:
  178. - To compile, you need the emx environment (at least rev. 0.9b), GCC,
  179.   some make utility (GNU make works fine). These are generally
  180.   available as (ask Archie about them):
  181.     emxrt.zip     emx runtime package
  182.     emxdev.zip    emx development system (without compiler)
  183.   GNU programs compiled for emx, patches and patched sources:
  184.     gnudev1.zip   GNU development tools compiled for emx (part 1)
  185.     gnudev2.zip   GNU development tools compiled for emx (part 2)
  186.     gnumake.zip   GNU make
  187. - Don't set a TERM environment variable; Vim defaults to os2ansi
  188.   which is available as a builtin termcap entry. Using other values
  189.   may give problems! (OS/2 ANSI emulation is quite limited.) If you
  190.   need to set TERM for other programs, you may consider putting
  191.   set term=os2ansi in the vimrc file.
  192.  
  193. Check vim_os2.txt for additional info on running Vim.
  194.  
  195.  
  196. 9. Atari MiNT
  197. =============
  198.  
  199.  
  200. To compile Vim for MiNT you may either copy makefile.mint to Makefile or use
  201. the Unix Makefile adapted for the MiNT configuration.
  202.  
  203. Now proceed as described in the Unix section.
  204.  
  205. Prerequisites:
  206.  
  207. You need a curses or termcap library that supports non-alphanumeric
  208. termcap names. If you don't have any, link with termlib.o.
  209.  
  210. -----------------------------------------------------------------------------
  211.  
  212. The rest of this file is based on the INSTALL file that comes with GNU
  213. autoconf 2.4. Not everything applies to Vim. Read Makefile too!
  214.  
  215.  
  216. Basic Installation
  217. ==================
  218.  
  219.    These are generic installation instructions.
  220.  
  221.    The `configure' shell script attempts to guess correct values for
  222. various system-dependent variables used during compilation.  It uses
  223. those values to create a `Makefile' in each directory of the package.
  224. It may also create one or more `.h' files containing system-dependent
  225. definitions.  Finally, it creates a shell script `config.status' that
  226. you can run in the future to recreate the current configuration, a file
  227. `config.cache' that saves the results of its tests to speed up
  228. reconfiguring, and a file `config.log' containing compiler output
  229. (useful mainly for debugging `configure').
  230.  
  231.    If you need to do unusual things to compile the package, please try
  232. to figure out how `configure' could check whether to do them, and mail
  233. diffs or instructions to the address given in the `README' so they can
  234. be considered for the next release.  If at some point `config.cache'
  235. contains results you don't want to keep, you may remove or edit it.
  236.  
  237.    The file `configure.in' is used to create `configure' by a program
  238. called `autoconf'.  You only need `configure.in' if you want to change
  239. it or regenerate `configure' using a newer version of `autoconf'.
  240.  
  241. The simplest way to compile this package is:
  242.  
  243.   1. `cd' to the directory containing the package's source code and type
  244.      `./configure' to configure the package for your system.  If you're
  245.      using `csh' on an old version of System V, you might need to type
  246.      `sh ./configure' instead to prevent `csh' from trying to execute
  247.      `configure' itself.
  248.  
  249.      Running `configure' takes awhile.  While running, it prints some
  250.      messages telling which features it is checking for.
  251.  
  252.   2. Type `make' to compile the package.
  253.  
  254.   4. Type `make install' to install the programs and any data files and
  255.      documentation.
  256.  
  257.   5. You can remove the program binaries and object files from the
  258.      source code directory by typing `make clean'.  To also remove the
  259.      files that `configure' created (so you can compile the package for
  260.      a different kind of computer), type `make distclean'.
  261.  
  262. Compilers and Options
  263. =====================
  264.  
  265.    Some systems require unusual options for compilation or linking that
  266. the `configure' script does not know about.  You can give `configure'
  267. initial values for variables by setting them in the environment.  Using
  268. a Bourne-compatible shell, you can do that on the command line like
  269. this:
  270.      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  271.  
  272. Or on systems that have the `env' program, you can do it like this:
  273.      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  274.  
  275. Or edit Makefile. There are examples lines with CC and CFLAGS that can be
  276. used by removing the '#' in column one. Some are for generic use, with
  277. debugger or optimizer. There are also lines for some specific systems.
  278.  
  279. Compiling For Multiple Architectures
  280. ====================================
  281.  
  282.    You can compile the package for more than one kind of computer at the
  283. same time, by placing the object files for each architecture in their
  284. own directory.  To do this, you must use a version of `make' that
  285. supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  286. directory where you want the object files and executables to go and run
  287. the `configure' script.  `configure' automatically checks for the
  288. source code in the directory that `configure' is in and in `..'.
  289.  
  290.    If you have to use a `make' that does not supports the `VPATH'
  291. variable, you have to compile the package for one architecture at a time
  292. in the source code directory.  After you have installed the package for
  293. one architecture, use `make distclean' before reconfiguring for another
  294. architecture.
  295.  
  296. Installation Names
  297. ==================
  298.  
  299.    By default, `make install' will install the package's files in
  300. `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  301. installation prefix other than `/usr/local' by giving `configure' the
  302. option `--prefix=PATH'.
  303.  
  304.    You can specify separate installation prefixes for
  305. architecture-specific files and architecture-independent files.  If you
  306. give `configure' the option `--exec-prefix=PATH', the package will use
  307. PATH as the prefix for installing programs and libraries.
  308. Documentation and other data files will still use the regular prefix.
  309.  
  310.    In addition, if you use an unusual directory layout you can give
  311. options like `--bindir=PATH' to specify different values for particular
  312. kinds of files.  Run `configure --help' for a list of the directories
  313. you can set and what kinds of files go in them.
  314.  
  315.    If the package supports it, you can cause programs to be installed
  316. with an extra prefix or suffix on their names by giving `configure' the
  317. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  318.  
  319. Optional Features
  320. =================
  321.  
  322.    Some packages pay attention to `--enable-FEATURE' options to
  323. `configure', where FEATURE indicates an optional part of the package.
  324. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  325. is something like `gnu-as' or `x' (for the X Window System).  The
  326. `README' should mention any `--enable-' and `--with-' options that the
  327. package recognizes.
  328.  
  329.    For packages that use the X Window System, `configure' can usually
  330. find the X include and library files automatically, but if it doesn't,
  331. you can use the `configure' options `--x-includes=DIR' and
  332. `--x-libraries=DIR' to specify their locations.
  333.  
  334. Specifying the System Type
  335. ==========================
  336.  
  337.    There may be some features `configure' can not figure out
  338. automatically, but needs to determine by the type of host the package
  339. will run on.  Usually `configure' can figure that out, but if it prints
  340. a message saying it can not guess the host type, give it the
  341. `--host=TYPE' option.  TYPE can either be a short name for the system
  342. type, such as `sun4', or a canonical name with three fields:
  343.      CPU-COMPANY-SYSTEM
  344.  
  345. See the file `config.sub' for the possible values of each field.  If
  346. `config.sub' isn't included in this package, then this package doesn't
  347. need to know the host type.
  348.  
  349.    If you are building compiler tools for cross-compiling, you can also
  350. use the `--target=TYPE' option to select the type of system they will
  351. produce code for and the `--build=TYPE' option to select the type of
  352. system on which you are compiling the package.
  353.  
  354. Sharing Defaults
  355. ================
  356.  
  357.    If you want to set default values for `configure' scripts to share,
  358. you can create a site shell script called `config.site' that gives
  359. default values for variables like `CC', `cache_file', and `prefix'.
  360. `configure' looks for `PREFIX/share/config.site' if it exists, then
  361. `PREFIX/etc/config.site' if it exists.  Or, you can set the
  362. `CONFIG_SITE' environment variable to the location of the site script.
  363. A warning: not all `configure' scripts look for a site script.
  364.  
  365. Operation Controls
  366. ==================
  367.  
  368.    `configure' recognizes the following options to control how it
  369. operates.
  370.  
  371. `--cache-file=FILE'
  372.      Use and save the results of the tests in FILE instead of
  373.      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
  374.      debugging `configure'.
  375.  
  376. `--help'
  377.      Print a summary of the options to `configure', and exit.
  378.  
  379. `--quiet'
  380. `--silent'
  381. `-q'
  382.      Do not print messages saying which checks are being made.
  383.  
  384. `--srcdir=DIR'
  385.      Look for the package's source code in directory DIR.  Usually
  386.      `configure' can determine that directory automatically.
  387.  
  388. `--version'
  389.      Print the version of Autoconf used to generate the `configure'
  390.      script, and exit.
  391.  
  392. `configure' also accepts some other, not widely useful, options.
  393.  
  394.